[DOC-14369] Add an icon page#51
Open
Rebecca-Martinez007 wants to merge 2 commits into
Open
Conversation
| @@ -0,0 +1,43 @@ | |||
| = Icons | |||
|
|
|||
Contributor
There was a problem hiding this comment.
Suggested change
| Use icons in the Couchbase documentation when: | |
| * You need to describe a clickable element in the UI that does not have a name label. | |
| * The clickable element is a Font Awesome icon. | |
sarahlwelton
requested changes
May 27, 2026
Contributor
sarahlwelton
left a comment
sarahlwelton
left a comment
There was a problem hiding this comment.
Sorry, but this doesn't tie into the existing documentation we have on style very well.
See:
^ Particularly that final bullet.
Same thing here:
^ Particularly the last bullet, again, and again, stating that a button might not have a defined border or colour/the X icon that's highlighted in the example image.
If we want to add this guidance, we need to do some more thinking about how to incorporate it into the existing guidance around buttons. Because really, an "icon" is still a button - at least the way you're describing it here.
You can leave this with me and I can make the changes, or you can take another stab at it. Let me know.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the UI Elements section, create a page for Icons.
The icons we use in the docs are Font Awesome V4.
Have the style for icons be something along the lines of: "click IconCopy (icon:fontawesome-icon[])." or if the button doesn’t have any copy, it could be written as "click icon:fontawesome-icon[]."
Images of Local Build: